Avoid attribute indirection with env (#13212)

sphinx-doc · Jan 5, 2025 · 83bf866 · 83bf866
1 parent 56c9e32
commit 83bf866
Show file tree

Hide file tree

Showing 42 changed files with 181 additions and 160 deletions.
diff --git a/doc/development/tutorials/examples/todo.py b/doc/development/tutorials/examples/todo.py
@@ -76,7 +76,7 @@ def process_todo_nodes(app, doctree, fromdocname):
 
     # Replace all todolist nodes with a list of the collected todos.
     # Augment each todo with a backlink to the original location.
-    env = app.builder.env
+    env = app.env
 
     if not hasattr(env, 'todo_all_todos'):
         env.todo_all_todos = []

diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py
@@ -48,6 +48,7 @@
 
 if TYPE_CHECKING:
     from collections.abc import Iterable, Sequence, Set
+    from pathlib import Path
 
     from docutils.nodes import Node
 
@@ -242,8 +243,8 @@ def compile_catalogs(self, catalogs: set[CatalogInfo], message: str) -> None:
         if not self.config.gettext_auto_build:
             return
 
-        def cat2relpath(cat: CatalogInfo) -> str:
-            return relpath(cat.mo_path, self.env.srcdir).replace(os.path.sep, SEP)
+        def cat2relpath(cat: CatalogInfo, srcdir: Path = self.srcdir) -> str:
+            return relpath(cat.mo_path, srcdir).replace(os.path.sep, SEP)
 
         logger.info(bold(__('building [mo]: ')) + message)
         for catalog in status_iterator(
@@ -615,22 +616,23 @@ def merge(docs: list[str], otherenv: bytes) -> None:
     @final
     def read_doc(self, docname: str, *, _cache: bool = True) -> None:
         """Parse a file and add/update inventory entries for the doctree."""
-        self.env.prepare_settings(docname)
+        env = self.env
+        env.prepare_settings(docname)
 
         # Add confdir/docutils.conf to dependencies list if exists
         docutilsconf = os.path.join(self.confdir, 'docutils.conf')
         if os.path.isfile(docutilsconf):
-            self.env.note_dependency(docutilsconf)
+            env.note_dependency(docutilsconf)
 
-        filename = str(self.env.doc2path(docname))
+        filename = str(env.doc2path(docname))
         filetype = get_filetype(self.app.config.source_suffix, filename)
         publisher = self.app.registry.get_publisher(self.app, filetype)
         self.env.current_document._parser = publisher.parser
         # record_dependencies is mutable even though it is in settings,
         # explicitly re-initialise for each document
         publisher.settings.record_dependencies = DependencyList()
         with (
-            sphinx_domains(self.env),
+            sphinx_domains(env),
             rst.default_role(docname, self.config.default_role),
         ):
             # set up error_handler for the target document
@@ -642,11 +644,11 @@ def read_doc(self, docname: str, *, _cache: bool = True) -> None:
             doctree = publisher.document
 
         # store time of reading, for outdated files detection
-        self.env.all_docs[docname] = time.time_ns() // 1_000
+        env.all_docs[docname] = time.time_ns() // 1_000
 
         # cleanup
-        self.env.current_document = _CurrentDocument()
-        self.env.ref_context.clear()
+        env.current_document = _CurrentDocument()
+        env.ref_context.clear()
 
         self.write_doctree(docname, doctree, _cache=_cache)
 

diff --git a/sphinx/builders/changes.py b/sphinx/builders/changes.py
@@ -128,7 +128,7 @@ def hl(no: int, line: str) -> str:
         logger.info(bold(__('copying source files...')))
         for docname in self.env.all_docs:
             with open(
-                self.env.doc2path(docname), encoding=self.env.config.source_encoding
+                self.env.doc2path(docname), encoding=self.config.source_encoding
             ) as f:
                 try:
                     lines = f.readlines()

diff --git a/sphinx/builders/gettext.py b/sphinx/builders/gettext.py
@@ -146,10 +146,8 @@ class I18nBuilder(Builder):
 
     def init(self) -> None:
         super().init()
-        self.env.set_versioning_method(
-            self.versioning_method, self.env.config.gettext_uuid
-        )
-        self.tags = I18nTags()
+        self.env.set_versioning_method(self.versioning_method, self.config.gettext_uuid)
+        self.tags = self.app.tags = I18nTags()
         self.catalogs: defaultdict[str, Catalog] = defaultdict(Catalog)
 
     def get_target_uri(self, docname: str, typ: str | None = None) -> str:
@@ -174,7 +172,7 @@ def write_doc(self, docname: str, doctree: nodes.document) -> None:
             if not _is_node_in_substitution_definition(node):
                 catalog.add(msg, node)
 
-        if 'index' in self.env.config.gettext_additional_targets:
+        if 'index' in self.config.gettext_additional_targets:
             # Extract translatable messages from index entries.
             for node, entries in traverse_translatable_index(doctree):
                 for entry_type, value, _target_id, _main, _category_key in entries:

diff --git a/sphinx/builders/html/__init__.py b/sphinx/builders/html/__init__.py
@@ -771,7 +771,7 @@ def write_domain_indices(self) -> None:
 
     def copy_image_files(self) -> None:
         if self.images:
-            stringify_func = ImageAdapter(self.app.env).get_original_image_uri
+            stringify_func = ImageAdapter(self.env).get_original_image_uri
             ensuredir(self._images_dir)
             for src in status_iterator(
                 self.images,

diff --git a/sphinx/builders/latex/__init__.py b/sphinx/builders/latex/__init__.py
@@ -476,7 +476,7 @@ def copy_latex_additional_files(self) -> None:
 
     def copy_image_files(self) -> None:
         if self.images:
-            stringify_func = ImageAdapter(self.app.env).get_original_image_uri
+            stringify_func = ImageAdapter(self.env).get_original_image_uri
             for src in status_iterator(
                 self.images,
                 __('copying images... '),

diff --git a/sphinx/builders/texinfo.py b/sphinx/builders/texinfo.py
@@ -196,7 +196,7 @@ def copy_assets(self) -> None:
 
     def copy_image_files(self, targetname: str) -> None:
         if self.images:
-            stringify_func = ImageAdapter(self.app.env).get_original_image_uri
+            stringify_func = ImageAdapter(self.env).get_original_image_uri
             for src in status_iterator(
                 self.images,
                 __('copying images... '),

diff --git a/sphinx/directives/__init__.py b/sphinx/directives/__init__.py
@@ -267,7 +267,7 @@ def run(self) -> list[Node]:
             finally:
                 # Private attributes for ToC generation. Will be modified or removed
                 # without notice.
-                if self.env.config.toc_object_entries:
+                if self.config.toc_object_entries:
                     signode['_toc_parts'] = self._object_hierarchy_parts(signode)
                     signode['_toc_name'] = self._toc_entry_name(signode)
                 else:

diff --git a/sphinx/domains/__init__.py b/sphinx/domains/__init__.py
@@ -107,6 +107,7 @@ class Domain:
     data_version = 0
 
     def __init__(self, env: BuildEnvironment) -> None:
+        domain_data: dict[str, dict[str, Any]] = env.domaindata
         self.env: BuildEnvironment = env
         self._role_cache: dict[str, RoleFunction] = {}
         self._directive_cache: dict[str, type[Directive]] = {}
@@ -119,13 +120,13 @@ def __init__(self, env: BuildEnvironment) -> None:
         self.roles = dict(self.roles)
         self.indices = list(self.indices)
 
-        if self.name not in env.domaindata:
+        if self.name not in domain_data:
             assert isinstance(self.initial_data, dict)
             new_data = copy.deepcopy(self.initial_data)
             new_data['version'] = self.data_version
-            self.data = env.domaindata[self.name] = new_data
+            self.data = domain_data[self.name] = new_data
         else:
-            self.data = env.domaindata[self.name]
+            self.data = domain_data[self.name]
             if self.data['version'] != self.data_version:
                 raise OSError('data of %r domain out of date' % self.label)
         for name, obj in self.object_types.items():

diff --git a/sphinx/domains/c/__init__.py b/sphinx/domains/c/__init__.py
@@ -219,7 +219,7 @@ def describe_signature(
         ast.describe_signature(signode, 'lastIsName', self.env, options)
 
     def run(self) -> list[Node]:
-        env = self.state.document.settings.env  # from ObjectDescription.run
+        env = self.env
         if env.current_document.c_parent_symbol is None:
             root = env.domaindata['c']['root_symbol']
             env.current_document.c_parent_symbol = root
@@ -235,16 +235,16 @@ def handle_signature(self, sig: str, signode: TextElement) -> ASTDeclaration:
         parent_symbol: Symbol = self.env.current_document.c_parent_symbol
 
         max_len = (
-            self.env.config.c_maximum_signature_line_length
-            or self.env.config.maximum_signature_line_length
+            self.config.c_maximum_signature_line_length
+            or self.config.maximum_signature_line_length
             or 0
         )
         signode['multi_line_parameter_list'] = (
             'single-line-parameter-list' not in self.options
             and (len(sig) > max_len > 0)
         )
 
-        parser = DefinitionParser(sig, location=signode, config=self.env.config)
+        parser = DefinitionParser(sig, location=signode, config=self.config)
         try:
             ast = self.parse_definition(parser)
             parser.assert_end()
@@ -400,7 +400,7 @@ def run(self) -> list[Node]:
             stack: list[Symbol] = []
         else:
             parser = DefinitionParser(
-                self.arguments[0], location=self.get_location(), config=self.env.config
+                self.arguments[0], location=self.get_location(), config=self.config
             )
             try:
                 name = parser.parse_namespace_object()
@@ -427,7 +427,7 @@ def run(self) -> list[Node]:
         if self.arguments[0].strip() in {'NULL', '0', 'nullptr'}:
             return []
         parser = DefinitionParser(
-            self.arguments[0], location=self.get_location(), config=self.env.config
+            self.arguments[0], location=self.get_location(), config=self.config
         )
         try:
             name = parser.parse_namespace_object()
@@ -567,7 +567,7 @@ def apply(self, **kwargs: Any) -> None:
             sig = node.sig
             parent_key = node.parentKey
             try:
-                parser = DefinitionParser(sig, location=node, config=self.env.config)
+                parser = DefinitionParser(sig, location=node, config=self.config)
                 name = parser.parse_xref_object()
             except DefinitionError as e:
                 logger.warning(e, location=node)
@@ -716,7 +716,7 @@ def __init__(self, asCode: bool) -> None:
     def run(self) -> tuple[list[Node], list[system_message]]:
         text = self.text.replace('\n', ' ')
         parser = DefinitionParser(
-            text, location=self.get_location(), config=self.env.config
+            text, location=self.get_location(), config=self.config
         )
         # attempt to mimic XRefRole classes, except that...
         try:

diff --git a/sphinx/domains/cpp/__init__.py b/sphinx/domains/cpp/__init__.py
@@ -259,7 +259,7 @@ def add_target_and_index(
                 break
         if not is_in_concept and 'no-index-entry' not in self.options:
             stripped_name = name
-            for prefix in self.env.config.cpp_index_common_prefix:
+            for prefix in self.config.cpp_index_common_prefix:
                 if name.startswith(prefix):
                     stripped_name = stripped_name[len(prefix) :]
                     break
@@ -308,7 +308,7 @@ def describe_signature(
         ast.describe_signature(signode, 'lastIsName', self.env, options)
 
     def run(self) -> list[Node]:
-        env = self.state.document.settings.env  # from ObjectDescription.run
+        env = self.env
         if env.current_document.cpp_parent_symbol is None:
             root = env.domaindata['cpp']['root_symbol']
             env.current_document.cpp_parent_symbol = root
@@ -348,16 +348,16 @@ def handle_signature(self, sig: str, signode: desc_signature) -> ASTDeclaration:
         parent_symbol: Symbol = self.env.current_document.cpp_parent_symbol
 
         max_len = (
-            self.env.config.cpp_maximum_signature_line_length
-            or self.env.config.maximum_signature_line_length
+            self.config.cpp_maximum_signature_line_length
+            or self.config.maximum_signature_line_length
             or 0
         )
         signode['multi_line_parameter_list'] = (
             'single-line-parameter-list' not in self.options
             and (len(sig) > max_len > 0)
         )
 
-        parser = DefinitionParser(sig, location=signode, config=self.env.config)
+        parser = DefinitionParser(sig, location=signode, config=self.config)
         try:
             ast = self.parse_definition(parser)
             parser.assert_end()
@@ -440,7 +440,7 @@ def _toc_entry_name(self, sig_node: desc_signature) -> str:
         if not sig_node.get('_toc_parts'):
             return ''
 
-        config = self.env.config
+        config = self.config
         objtype = sig_node.parent.get('objtype')
         if config.add_function_parentheses and objtype in {'function', 'method'}:
             parens = '()'
@@ -710,7 +710,7 @@ def apply(self, **kwargs: Any) -> None:
             sig = node.sig
             parent_key = node.parentKey
             try:
-                parser = DefinitionParser(sig, location=node, config=self.env.config)
+                parser = DefinitionParser(sig, location=node, config=self.config)
                 ast, is_shorthand = parser.parse_xref_object()
                 parser.assert_end()
             except DefinitionError as e:

diff --git a/sphinx/domains/javascript.py b/sphinx/domains/javascript.py
@@ -101,8 +101,8 @@ def handle_signature(self, sig: str, signode: desc_signature) -> tuple[str, str]
         signode['fullname'] = fullname
 
         max_len = (
-            self.env.config.javascript_maximum_signature_line_length
-            or self.env.config.maximum_signature_line_length
+            self.config.javascript_maximum_signature_line_length
+            or self.config.maximum_signature_line_length
             or 0
         )
         multi_line_parameter_list = (
@@ -238,7 +238,7 @@ def _toc_entry_name(self, sig_node: desc_signature) -> str:
         if not sig_node.get('_toc_parts'):
             return ''
 
-        config = self.env.config
+        config = self.config
         objtype = sig_node.parent.get('objtype')
         if config.add_function_parentheses and objtype in {'function', 'method'}:
             parens = '()'

diff --git a/sphinx/domains/python/__init__.py b/sphinx/domains/python/__init__.py
@@ -261,7 +261,7 @@ def get_index_text(self, modname: str, name_cls: tuple[str, str]) -> str:
         name, cls = name_cls
         try:
             clsname, methname = name.rsplit('.', 1)
-            if modname and self.env.config.add_module_names:
+            if modname and self.config.add_module_names:
                 clsname = f'{modname}.{clsname}'
         except ValueError:
             if modname:
@@ -357,7 +357,7 @@ def get_index_text(self, modname: str, name_cls: tuple[str, str]) -> str:
         name, cls = name_cls
         try:
             clsname, attrname = name.rsplit('.', 1)
-            if modname and self.env.config.add_module_names:
+            if modname and self.config.add_module_names:
                 clsname = f'{modname}.{clsname}'
         except ValueError:
             if modname:
@@ -417,7 +417,7 @@ def get_index_text(self, modname: str, name_cls: tuple[str, str]) -> str:
         name, cls = name_cls
         try:
             clsname, attrname = name.rsplit('.', 1)
-            if modname and self.env.config.add_module_names:
+            if modname and self.config.add_module_names:
                 clsname = f'{modname}.{clsname}'
         except ValueError:
             if modname:
@@ -457,7 +457,7 @@ def get_index_text(self, modname: str, name_cls: tuple[str, str]) -> str:
         name, cls = name_cls
         try:
             clsname, attrname = name.rsplit('.', 1)
-            if modname and self.env.config.add_module_names:
+            if modname and self.config.add_module_names:
                 clsname = f'{modname}.{clsname}'
         except ValueError:
             if modname:

diff --git a/sphinx/domains/python/_object.py b/sphinx/domains/python/_object.py
@@ -286,8 +286,8 @@ def handle_signature(self, sig: str, signode: desc_signature) -> tuple[str, str]
         signode['fullname'] = fullname
 
         max_len = (
-            self.env.config.python_maximum_signature_line_length
-            or self.env.config.maximum_signature_line_length
+            self.config.python_maximum_signature_line_length
+            or self.config.maximum_signature_line_length
             or 0
         )
 
@@ -321,7 +321,7 @@ def handle_signature(self, sig: str, signode: desc_signature) -> tuple[str, str]
 
         if prefix:
             signode += addnodes.desc_addname(prefix, prefix)
-        elif modname and add_module and self.env.config.add_module_names:
+        elif modname and add_module and self.config.add_module_names:
             nodetext = f'{modname}.'
             signode += addnodes.desc_addname(nodetext, nodetext)
 
@@ -474,7 +474,7 @@ def _toc_entry_name(self, sig_node: desc_signature) -> str:
         if not sig_node.get('_toc_parts'):
             return ''
 
-        config = self.env.config
+        config = self.config
         objtype = sig_node.parent.get('objtype')
         if config.add_function_parentheses and objtype in {'function', 'method'}:
             parens = '()'

diff --git a/sphinx/domains/rst.py b/sphinx/domains/rst.py
@@ -84,12 +84,11 @@ def _toc_entry_name(self, sig_node: desc_signature) -> str:
         if not sig_node.get('_toc_parts'):
             return ''
 
-        config = self.env.config
         objtype = sig_node.parent.get('objtype')
         *parents, name = sig_node['_toc_parts']
         if objtype == 'directive:option':
             return f':{name}:'
-        if config.toc_object_entries_show_parents in {'domain', 'all'}:
+        if self.config.toc_object_entries_show_parents in {'domain', 'all'}:
             name = ':'.join(sig_node['_toc_parts'])
         if objtype == 'role':
             return f':{name}:'

diff --git a/sphinx/domains/std/__init__.py b/sphinx/domains/std/__init__.py
@@ -258,13 +258,13 @@ def handle_signature(self, sig: str, signode: desc_signature) -> str:
                 args = '[' + args
 
             if count:
-                if self.env.config.option_emphasise_placeholders:
+                if self.config.option_emphasise_placeholders:
                     signode += addnodes.desc_sig_punctuation(',', ',')
                     signode += addnodes.desc_sig_space()
                 else:
                     signode += addnodes.desc_addname(', ', ', ')
             signode += addnodes.desc_name(optname, optname)
-            if self.env.config.option_emphasise_placeholders:
+            if self.config.option_emphasise_placeholders:
                 add_end_bracket = False
                 if args:
                     if args[0] == '[' and args[-1] == ']':